/*
 * Copyright (c) 2025, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
package jdk.graal.compiler.truffle.phases;

import java.util.function.Function;

import jdk.graal.compiler.nodes.StructuredGraph;
import jdk.graal.compiler.options.OptionValues;
import jdk.graal.compiler.phases.PhaseSuite;
import jdk.graal.compiler.phases.common.CanonicalizerPhase;
import jdk.graal.compiler.phases.util.Providers;
import jdk.graal.compiler.truffle.KnownTruffleTypes;
import jdk.vm.ci.meta.ResolvedJavaMethod;
import jdk.vm.ci.meta.ResolvedJavaType;

/**
 * This suite is intended to run on every graph prior to partial evaluation. It is not optional, as
 * it implements semantics that are required for the Truffle compilation to succeed. It is strongly
 * recommended to cache the result of this phase to not repeat it for every time a method is partial
 * evaluated.
 */
public final class PrePartialEvaluationSuite extends PhaseSuite<Providers> {

    @SuppressWarnings("this-escape")
    public PrePartialEvaluationSuite(OptionValues optionValues, KnownTruffleTypes truffleTypes, Providers providers, CanonicalizerPhase canonicalizer,
                    Function<ResolvedJavaMethod, StructuredGraph> graphLookup, Function<ResolvedJavaType, ResolvedJavaType> unwrapType) {
        // only if Truffle is installed we can apply these phases.
        appendPhase(new TruffleEarlyInliningPhase(optionValues, canonicalizer, truffleTypes, providers, graphLookup, unwrapType));
        appendPhase(new TruffleEarlyEscapeAnalysisPhase(canonicalizer, optionValues, truffleTypes, unwrapType));

    }

}
